Improve changelog bundle --output#2458
Merged
lcawl merged 1 commit intochangelog-manifestfrom Jan 14, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updated the
docs-builder changelog bundlecommand's--outputoption and updated documentation and tests.Impetus
While testing #2452 I encountered problems specifying an output directory for the bundle since it was interpreting part of the output path as a filename.
Changes Made:
src/tooling/docs-builder/Commands/ChangelogCommand.cs):--outputto accept:changelog-bundle.yamlin that directory.ymlor.yaml: uses that exact path.ymlor.yamldocs/contribute/changelog.mdanddocs/cli/release/changelog-bundle.md):--outputoption descriptiontests/Elastic.Documentation.Services.Tests/ChangelogServiceTests.cs):BundleChangelogs_WithDirectoryOutputPath_CreatesDefaultFilenameto verify directory-only output paths work correctlyAll 31 bundle-related tests pass
Behavior
--output /path/to/dir→ creates/path/to/dir/changelog-bundle.yaml--output /path/to/file.yaml→creates /path/to/file.yaml--output /path/to/file.txt→ error (must end in.ymlor.yaml)The implementation is backward compatible: existing tests continue to pass, and the service layer already handles directory creation.
Generative AI disclosure
Tool(s) and model(s) used: composer-1 agent